Avoid phantom values in NDK Metadata #1700
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal
Fix a bug when overwriting of clearing metadata, the NDK did not always remove the value as expected leading to phantom metadata values in reports. For example:
Would typically result in the Event having
"value1"
in its reported metadata, instead of no value as expected.Design
Introduce a simple compacting function which will remove any duplicates and gaps in the metadata array and compact it.
This new function is used when either:
By retaining the insertion order of the metadata we introduce minimal additional overhead on the most common path: adding metadata. The correct values are retained as the most recent values are always the last in the array (effectively acting as a primitive journal).
Designs considered but not used
add
functions - this would have introduce unacceptable overheadsTesting
Modified the existing end-to-end test which deletes metadata before a native crash